Add Fee Profile

'CreateFeeProfile' API enables to create a fee profile for an account

Bank or financial institution can create new fee profile for an account and can assign it for specific transaction process. On providing respective account ID for which the profile to be created along with transaction type and fee details as request, the new fee profile is created with an ID.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to create new fee profile through fee service Constant value: "FeeService.CreateFeeProfile"
id Mandatory	String Unique ID of API request Sample value: "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value: "signature"
keyId Mandatory	String API key used for request authentication Sample value: "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value: "Credential"
payload Mandatory	Object
name Mandatory	String Name of the Fee profile Sample value: accountFee
accountID Optional	String Unique ID of the account for which the fee profile is created Sample value: 9007
transactionFees Conditional Mandatory	Array (Mandatory for all except monthly fee)
transactionType Conditional Mandatory	String Type of transaction for which the fee is applicable (Mandatory for all except monthly fee) Sample value: "R2P"
feeAmount Conditional Mandatory	Number Per transaction fee in cents (Mandatory if 'transactionFees' is applicable) Sample value: 90
tax Optional	Number Tax in percentage of fee amount Sample value: 3

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"FeeService.CreateFeeProfile","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"name":"accountFee","accountID":"9007","transactionFees":[{"transactionType":"R2P","feeAmount":90,"tax":3}]}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""FeeService.CreateFeeProfile"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""name"": ""accountFee"",
" + "\n" +
@"      ""accountID"": ""9007"",
" + "\n" +
@"      ""transactionFees"": [
" + "\n" +
@"        {
" + "\n" +
@"          ""transactionType"": ""R2P"",
" + "\n" +
@"          ""feeAmount"": 90,
" + "\n" +
@"          ""tax"": 3
" + "\n" +
@"        }
" + "\n" +
@"      ]
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "FeeService.CreateFeeProfile",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "name": "accountFee",`+"
"+`
      "accountID": "9007",`+"
"+`
      "transactionFees": [`+"
"+`
        {`+"
"+`
          "transactionType": "R2P",`+"
"+`
          "feeAmount": 90,`+"
"+`
          "tax": 3`+"
"+`
        }`+"
"+`
      ]`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJS

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "FeeService.CreateFeeProfile",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "name": "accountFee",
      "accountID": "9007",
      "transactionFees": [
        {
          "transactionType": "R2P",
          "feeAmount": 90,
          "tax": 3
        }
      ]
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "FeeService.CreateFeeProfile",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "name": "accountFee",
      "accountID": "9007",
      "transactionFees": [
        {
          "transactionType": "R2P",
          "feeAmount": 90, //Either feeAmount or subsidiary is required if 'transactionFees' is applicable
          "tax": 3
        }
      ]
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value: "1"
result	Object
ID	String Fee profile ID assigned to the account Sample value: "41003"

{
  "id": "1",
  "result": {
    "ID": "41003"
  }
}